Summarizer: summarize() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die summarize() Methode der Summarizer-Schnittstelle erzeugt eine neue Zusammenfassungszeichenkette.

Syntax

js
summarize(input)
summarize(input, options)

Parameter

input

Ein String, der den zu zusammenfassenden Text darstellt.

options Optional

Ein Objekt, das Konfigurationsoptionen für die summarize()-Operation angibt. Mögliche Werte sind:

context

Ein String, der den Kontext beschreibt, in dem der Eingabetext verwendet wird, was dem Summarizer hilft, eine passendere Zusammenfassung zu erzeugen.

signal

Eine Instanz des AbortSignal-Objekts, die es ermöglicht, die summarize()-Operation über den zugehörigen AbortController abzubrechen.

Rückgabewert

Ein Promise, der mit einem String erfüllt wird, der die erzeugte Zusammenfassung enthält.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn das aktuelle Document nicht aktiv ist.

NotAllowedError DOMException

Wird ausgelöst, wenn die Nutzung der Summarizer API durch eine summarizer Permissions-Policy blockiert wird.

NotReadableError DOMException

Wird ausgelöst, wenn die erzeugte Zusammenfassung vom Benutzeragenten gefiltert wurde, zum Beispiel, weil sie als schädlich, ungenau oder sinnlos erkannt wurde.

NotSupportedError DOMException

Wird ausgelöst, wenn der bereitgestellte context nicht in einer vom Summarizer unterstützten Sprache ist.

QuotaExceededError DOMException

Wird ausgelöst, wenn die Zusammenfassungsoperation das verfügbare inputQuota überschreitet.

UnknownError DOMException

Wird ausgelöst, wenn der summarize() Aufruf aus einem anderen Grund fehlschlug oder aus einem Grund, den der Benutzeragent nicht offenlegen wollte.

Beispiele

Grundlegende summarize()-Verwendung

js
const summarizer = await Summarizer.create({
  sharedContext:
    "A general summary to help a user decide if the text is worth reading",
  type: "tldr",
  length: "short",
});

const summary = await summarizer.summarize(myTextString);
console.log(summary);

Spezifikationen

Specification
Writing Assistance APIs
# dom-summarizer-summarize

Browser-Kompatibilität

Siehe auch